/*------------------------------------------------------------------------
 *  Image
 *
 *  Copyright 2007-2010 (c) Jeff Brown <spadix@users.sourceforge.net>
 *
 *  This file is part of the ZBar Bar Code Reader.
 *
 *  The ZBar Bar Code Reader is free software; you can redistribute it
 *  and/or modify it under the terms of the GNU Lesser Public License as
 *  published by the Free Software Foundation; either version 2.1 of
 *  the License, or (at your option) any later version.
 *
 *  The ZBar Bar Code Reader is distributed in the hope that it will be
 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 *  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser Public License
 *  along with the ZBar Bar Code Reader; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 *  Boston, MA  02110-1301  USA
 *
 *  http://sourceforge.net/projects/zbar
 *------------------------------------------------------------------------*/

package net.sourceforge.zbar;

/**
 * stores image data samples along with associated format and size metadata.
 */
public class Image {
	/** C pointer to a zbar_symbol_t. */
	private long peer;
	private Object data;

	static {
		System.loadLibrary(Config.LIB_ZBAR_DECODER_NAME);
		init();
	}

	private static native void init();

	public Image() {
		peer = create();
	}

	public Image(int width, int height) {
		this();
		setSize(width, height);
	}

	public Image(int width, int height, String format) {
		this();
		setSize(width, height);
		setFormat(format);
	}

	public Image(String format) {
		this();
		setFormat(format);
	}

	Image(long peer) {
		this.peer = peer;
	}

	/** Create an associated peer instance. */
	private native long create();

	protected void finalize() {
		destroy();
	}

	/** Clean up native data associated with an instance. */
	public synchronized void destroy() {
		if (peer != 0) {
			destroy(peer);
			peer = 0;
		}
	}

	/** Destroy the associated peer instance. */
	private native void destroy(long peer);

	/**
	 * Image format conversion.
	 * 
	 * @returns a @em new image with the sample data from the original image
	 *          converted to the requested format fourcc. the original image is
	 *          unaffected.
	 */
	public Image convert(String format) {
		long newpeer = convert(peer, format);
		if (newpeer == 0)
			return (null);
		return (new Image(newpeer));
	}

	private native long convert(long peer, String format);

	/** Retrieve the image format fourcc. */
	public native String getFormat();

	/** Specify the fourcc image format code for image sample data. */
	public native void setFormat(String format);

	/**
	 * Retrieve a "sequence" (page/frame) number associated with this image.
	 */
	public native int getSequence();

	/** Associate a "sequence" (page/frame) number with this image. */
	public native void setSequence(int seq);

	/** Retrieve the width of the image. */
	public native int getWidth();

	/** Retrieve the height of the image. */
	public native int getHeight();

	/** Retrieve the size of the image. */
	public native int[] getSize();

	/** Specify the pixel size of the image. */
	public native void setSize(int width, int height);

	/** Specify the pixel size of the image. */
	public native void setSize(int[] size);

	/** Retrieve the crop region of the image. */
	public native int[] getCrop();

	/** Specify the crop region of the image. */
	public native void setCrop(int x, int y, int width, int height);

	/** Specify the crop region of the image. */
	public native void setCrop(int[] crop);

	/** Retrieve the image sample data. */
	public native byte[] getData();

	/** Specify image sample data. */
	public native void setData(byte[] data);

	/** Specify image sample data. */
	public native void setData(int[] data);

	/** Retrieve the decoded results associated with this image. */
	public SymbolSet getSymbols() {
		return (new SymbolSet(getSymbols(peer)));
	}

	private native long getSymbols(long peer);

}
